<!-- This comment will put IE 6, 7 and 8 in quirks mode -->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>shark::TrainingProgress&lt; PointType &gt; Class Template Reference</title>
<script type="text/javaScript" src="search/search.js"></script>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script src="https://polyfill.io/v3/polyfill.min.js?features=es6"></script>
<script id="MathJax-script" async src="https://cdn.jsdelivr.net/npm/mathjax@3.0.1/es5/tex-mml-chtml.js"></script>
<script src="../../mlstyle.js"></script>
<link href="../css/besser.css" rel="stylesheet" type="text/css"/>
</head>
<!-- pretty cool: each body gets an id tag which is the basename of the web page  -->
<!--              and allows for page-specific CSS. this is client-side scripted, -->
<!--              so the id will not yet show up in the served source code -->
<script type="text/javascript">
    jQuery(document).ready(function () {
        var url = jQuery(location).attr('href');
        var pname = url.substr(url.lastIndexOf("/")+1, url.lastIndexOf(".")-url.lastIndexOf("/")-1);
        jQuery('#this_url').html('<strong>' + pname + '</strong>');
        jQuery('body').attr('id', pname);
    });
</script>
<body>
    <div id="shark_old">
        <div id="wrap">
            <div id="header">
                <div id="site-name"><a href="../../sphinx_pages/build/html/index.html">Shark machine learning library</a></div>
                <ul id="nav">
                    <li >
                        <a href="../../sphinx_pages/build/html/rest_sources/installation.html">Installation</a>
                    </li>
		    <li >
                        <a href="../../sphinx_pages/build/html/rest_sources/tutorials/tutorials.html">Tutorials</a>
                    </li>
		    <li >
                        <a href="../../sphinx_pages/build/html/rest_sources/benchmark.html">Benchmarks</a>
                    </li>
                    <li class="active">
                        <a href="classes.html">Documentation</a>
                        <ul>
                            <li class="first"></li>
                            <li><a href="../../sphinx_pages/build/html/rest_sources/quickref/quickref.html">Quick references</a></li>
                            <li><a href="classes.html">Class list</a></li>
                            <li class="last"><a href="group__shark__globals.html">Global functions</a></li>
                        </ul>
                    </li>
                </ul>
            </div>
        </div>
    </div>
<div id="doxywrapper">
<!--
    <div id="global_doxytitle">Doxygen<br>Documentation:</div>
-->
    <div id="navrow_wrapper">
<!-- Generated by Doxygen 1.9.8 -->
<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="namespaceshark.html">shark</a></li><li class="navelem"><a class="el" href="classshark_1_1_training_progress.html">TrainingProgress</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="classshark_1_1_training_progress-members.html">List of all members</a> &#124;
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a>  </div>
  <div class="headertitle"><div class="title">shark::TrainingProgress&lt; PointType &gt; Class Template Reference</div></div>
</div><!--header-->
<div class="contents">

<p>This stopping criterion tracks the improvement of the training error over an interval of iterations.  
 <a href="classshark_1_1_training_progress.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="_training_progress_8h_source.html">shark/Algorithms/StoppingCriteria/TrainingProgress.h</a>&gt;</code></p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
  <img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for shark::TrainingProgress&lt; PointType &gt;:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center"><img src="classshark_1_1_training_progress__inherit__graph.png" border="0" usemap="#ashark_1_1_training_progress_3_01_point_type_01_4_inherit__map" alt="Inheritance graph"/></div>
<map name="ashark_1_1_training_progress_3_01_point_type_01_4_inherit__map" id="ashark_1_1_training_progress_3_01_point_type_01_4_inherit__map">
<area shape="rect" title="This stopping criterion tracks the improvement of the training error over an interval of iterations." alt="" coords="31,94,190,135"/>
<area shape="rect" href="classshark_1_1_abstract_stopping_criterion.html" title="Base class for stopping criteria of optimization algorithms." alt="" coords="5,5,216,46"/>
<area shape="poly" title=" " alt="" coords="113,62,113,94,108,94,108,62"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-types" name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a313c1aa65f6489d735fce017d01cfc94" id="r_a313c1aa65f6489d735fce017d01cfc94"><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="structshark_1_1_single_objective_result_set.html">SingleObjectiveResultSet</a>&lt; PointType &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classshark_1_1_training_progress.html#a313c1aa65f6489d735fce017d01cfc94">ResultSet</a></td></tr>
<tr class="separator:a313c1aa65f6489d735fce017d01cfc94"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_types_classshark_1_1_abstract_stopping_criterion"><td colspan="2" onclick="javascript:toggleInherit('pub_types_classshark_1_1_abstract_stopping_criterion')"><img src="closed.png" alt="-"/>&#160;Public Types inherited from <a class="el" href="classshark_1_1_abstract_stopping_criterion.html">shark::AbstractStoppingCriterion&lt; ResultSetT &gt;</a></td></tr>
<tr class="memitem:aa813314942f2e999ac8b9c985d001f96 inherit pub_types_classshark_1_1_abstract_stopping_criterion" id="r_aa813314942f2e999ac8b9c985d001f96"><td class="memItemLeft" align="right" valign="top">typedef ResultSetT&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classshark_1_1_abstract_stopping_criterion.html#aa813314942f2e999ac8b9c985d001f96">ResultSet</a></td></tr>
<tr class="separator:aa813314942f2e999ac8b9c985d001f96 inherit pub_types_classshark_1_1_abstract_stopping_criterion"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a519e14c11c239f4aae0a1d0cf82b792f" id="r_a519e14c11c239f4aae0a1d0cf82b792f"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classshark_1_1_training_progress.html#a519e14c11c239f4aae0a1d0cf82b792f">TrainingProgress</a> (size_t intervalSize, double minImprovement)</td></tr>
<tr class="separator:a519e14c11c239f4aae0a1d0cf82b792f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af320c01d4e54853e8fd3e891488bfba4" id="r_af320c01d4e54853e8fd3e891488bfba4"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classshark_1_1_training_progress.html#af320c01d4e54853e8fd3e891488bfba4">stop</a> (const <a class="el" href="classshark_1_1_training_progress.html#a313c1aa65f6489d735fce017d01cfc94">ResultSet</a> &amp;set)</td></tr>
<tr class="memdesc:af320c01d4e54853e8fd3e891488bfba4"><td class="mdescLeft">&#160;</td><td class="mdescRight">returns true if training should stop  <br /></td></tr>
<tr class="separator:af320c01d4e54853e8fd3e891488bfba4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6244cca3d61f3d5ce1dee922ed9415ff" id="r_a6244cca3d61f3d5ce1dee922ed9415ff"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classshark_1_1_training_progress.html#a6244cca3d61f3d5ce1dee922ed9415ff">reset</a> ()</td></tr>
<tr class="memdesc:a6244cca3d61f3d5ce1dee922ed9415ff"><td class="mdescLeft">&#160;</td><td class="mdescRight">resets the internal state  <br /></td></tr>
<tr class="separator:a6244cca3d61f3d5ce1dee922ed9415ff"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aff4a12440a29b6dc3f9ace7b11642a7c" id="r_aff4a12440a29b6dc3f9ace7b11642a7c"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classshark_1_1_training_progress.html#aff4a12440a29b6dc3f9ace7b11642a7c">value</a> () const</td></tr>
<tr class="memdesc:aff4a12440a29b6dc3f9ace7b11642a7c"><td class="mdescLeft">&#160;</td><td class="mdescRight">returns current value of progress  <br /></td></tr>
<tr class="separator:aff4a12440a29b6dc3f9ace7b11642a7c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classshark_1_1_abstract_stopping_criterion"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classshark_1_1_abstract_stopping_criterion')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classshark_1_1_abstract_stopping_criterion.html">shark::AbstractStoppingCriterion&lt; ResultSetT &gt;</a></td></tr>
<tr class="memitem:a74a1d1aea141cf2ad5d69e29cb90f25c inherit pub_methods_classshark_1_1_abstract_stopping_criterion" id="r_a74a1d1aea141cf2ad5d69e29cb90f25c"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classshark_1_1_abstract_stopping_criterion.html#a74a1d1aea141cf2ad5d69e29cb90f25c">stop</a> (<a class="el" href="classshark_1_1_abstract_stopping_criterion.html#aa813314942f2e999ac8b9c985d001f96">ResultSet</a> const &amp;set)=0</td></tr>
<tr class="separator:a74a1d1aea141cf2ad5d69e29cb90f25c inherit pub_methods_classshark_1_1_abstract_stopping_criterion"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-attribs" name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:aab3746ac8b741a666ad8c1eb5bb115e3" id="r_aab3746ac8b741a666ad8c1eb5bb115e3"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classshark_1_1_training_progress.html#aab3746ac8b741a666ad8c1eb5bb115e3">m_minTraining</a></td></tr>
<tr class="memdesc:aab3746ac8b741a666ad8c1eb5bb115e3"><td class="mdescLeft">&#160;</td><td class="mdescRight">minimum training error encountered  <br /></td></tr>
<tr class="separator:aab3746ac8b741a666ad8c1eb5bb115e3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae3ac4627d5824dd0f29d551fdc3857c6" id="r_ae3ac4627d5824dd0f29d551fdc3857c6"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classshark_1_1_training_progress.html#ae3ac4627d5824dd0f29d551fdc3857c6">m_minImprovement</a></td></tr>
<tr class="memdesc:ae3ac4627d5824dd0f29d551fdc3857c6"><td class="mdescLeft">&#160;</td><td class="mdescRight">minimum improvement allowed before training stops  <br /></td></tr>
<tr class="separator:ae3ac4627d5824dd0f29d551fdc3857c6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7a77079e0170e3ebb94ee452e8c96bae" id="r_a7a77079e0170e3ebb94ee452e8c96bae"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classshark_1_1_training_progress.html#a7a77079e0170e3ebb94ee452e8c96bae">m_meanPerformance</a></td></tr>
<tr class="memdesc:a7a77079e0170e3ebb94ee452e8c96bae"><td class="mdescLeft">&#160;</td><td class="mdescRight">mean performance over the last intervalSize timesteps  <br /></td></tr>
<tr class="separator:a7a77079e0170e3ebb94ee452e8c96bae"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac49c25a85c635d8930a4b4216f787a8a" id="r_ac49c25a85c635d8930a4b4216f787a8a"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classshark_1_1_training_progress.html#ac49c25a85c635d8930a4b4216f787a8a">m_progress</a></td></tr>
<tr class="memdesc:ac49c25a85c635d8930a4b4216f787a8a"><td class="mdescLeft">&#160;</td><td class="mdescRight">current progress measure. if it is below minTraining, <a class="el" href="classshark_1_1_training_progress.html#af320c01d4e54853e8fd3e891488bfba4" title="returns true if training should stop">stop()</a> will return true  <br /></td></tr>
<tr class="separator:ac49c25a85c635d8930a4b4216f787a8a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a28ee365a24266f795f928be8e9352ba3" id="r_a28ee365a24266f795f928be8e9352ba3"><td class="memItemLeft" align="right" valign="top">std::queue&lt; double &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classshark_1_1_training_progress.html#a28ee365a24266f795f928be8e9352ba3">m_interval</a></td></tr>
<tr class="memdesc:a28ee365a24266f795f928be8e9352ba3"><td class="mdescLeft">&#160;</td><td class="mdescRight">current interval  <br /></td></tr>
<tr class="separator:a28ee365a24266f795f928be8e9352ba3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a932d896b5b2d8b2689caef279c710b2d" id="r_a932d896b5b2d8b2689caef279c710b2d"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classshark_1_1_training_progress.html#a932d896b5b2d8b2689caef279c710b2d">m_intervalSize</a></td></tr>
<tr class="memdesc:a932d896b5b2d8b2689caef279c710b2d"><td class="mdescLeft">&#160;</td><td class="mdescRight">size of the interval  <br /></td></tr>
<tr class="separator:a932d896b5b2d8b2689caef279c710b2d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><div class="compoundTemplParams">template&lt;class PointType = RealVector&gt;<br />
class shark::TrainingProgress&lt; PointType &gt;</div><p>This stopping criterion tracks the improvement of the training error over an interval of iterations. </p>
<p>If the mean performance over this strip divided by the minimum is too low, training is stopped. The difference to <a class="el" href="classshark_1_1_training_error.html" title="This stopping criterion tracks the improvement of the error function of the training error over an in...">TrainingError</a> is, that this class tests the relative improvement of the error compared to the minimum training error, while the <a class="el" href="classshark_1_1_training_error.html" title="This stopping criterion tracks the improvement of the error function of the training error over an in...">TrainingError</a> measures the absolute difference. This class is a bit better tuned to noisy error functions since it takes the mean of the interval as comparison.</p>
<p>Terminology for this and other stopping criteria is taken from (and also see):</p>
<p>Lutz Prechelt. Early Stopping - but when? In Genevieve B. Orr and Klaus-Robert Müller: Neural Networks: Tricks of the Trade, volume 1524 of LNCS, Springer, 1997. </p>

<p class="definition">Definition at line <a class="el" href="_training_progress_8h_source.html#l00059">59</a> of file <a class="el" href="_training_progress_8h_source.html">TrainingProgress.h</a>.</p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a id="a313c1aa65f6489d735fce017d01cfc94" name="a313c1aa65f6489d735fce017d01cfc94"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a313c1aa65f6489d735fce017d01cfc94">&#9670;&#160;</a></span>ResultSet</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class PointType  = RealVector&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">typedef <a class="el" href="structshark_1_1_single_objective_result_set.html">SingleObjectiveResultSet</a>&lt;PointType&gt; <a class="el" href="classshark_1_1_training_progress.html">shark::TrainingProgress</a>&lt; PointType &gt;::ResultSet</td>
        </tr>
      </table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="_training_progress_8h_source.html#l00061">61</a> of file <a class="el" href="_training_progress_8h_source.html">TrainingProgress.h</a>.</p>

</div>
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a519e14c11c239f4aae0a1d0cf82b792f" name="a519e14c11c239f4aae0a1d0cf82b792f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a519e14c11c239f4aae0a1d0cf82b792f">&#9670;&#160;</a></span>TrainingProgress()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class PointType  = RealVector&gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classshark_1_1_training_progress.html">shark::TrainingProgress</a>&lt; PointType &gt;::TrainingProgress </td>
          <td>(</td>
          <td class="paramtype">size_t&#160;</td>
          <td class="paramname"><em>intervalSize</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">double&#160;</td>
          <td class="paramname"><em>minImprovement</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>constructs the <a class="el" href="classshark_1_1_training_progress.html" title="This stopping criterion tracks the improvement of the training error over an interval of iterations.">TrainingProgress</a> </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">intervalSize</td><td>the size of the interval which is checked </td></tr>
    <tr><td class="paramname">minImprovement</td><td>minimum relative improvement of the interval to the minimum training error before training stops </td></tr>
  </table>
  </dd>
</dl>

<p class="definition">Definition at line <a class="el" href="_training_progress_8h_source.html#l00065">65</a> of file <a class="el" href="_training_progress_8h_source.html">TrainingProgress.h</a>.</p>

<p class="reference">References <a class="el" href="classshark_1_1_training_progress.html#a932d896b5b2d8b2689caef279c710b2d">shark::TrainingProgress&lt; PointType &gt;::m_intervalSize</a>, <a class="el" href="classshark_1_1_training_progress.html#ae3ac4627d5824dd0f29d551fdc3857c6">shark::TrainingProgress&lt; PointType &gt;::m_minImprovement</a>, and <a class="el" href="classshark_1_1_training_progress.html#a6244cca3d61f3d5ce1dee922ed9415ff">shark::TrainingProgress&lt; PointType &gt;::reset()</a>.</p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a6244cca3d61f3d5ce1dee922ed9415ff" name="a6244cca3d61f3d5ce1dee922ed9415ff"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6244cca3d61f3d5ce1dee922ed9415ff">&#9670;&#160;</a></span>reset()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class PointType  = RealVector&gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="classshark_1_1_training_progress.html">shark::TrainingProgress</a>&lt; PointType &gt;::reset </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>resets the internal state </p>

<p>Implements <a class="el" href="classshark_1_1_abstract_stopping_criterion.html#a2cd08d7ec1a7627ad17ce451b8ba915c">shark::AbstractStoppingCriterion&lt; ResultSetT &gt;</a>.</p>

<p class="definition">Definition at line <a class="el" href="_training_progress_8h_source.html#l00090">90</a> of file <a class="el" href="_training_progress_8h_source.html">TrainingProgress.h</a>.</p>

<p class="reference">References <a class="el" href="classshark_1_1_training_progress.html#a28ee365a24266f795f928be8e9352ba3">shark::TrainingProgress&lt; PointType &gt;::m_interval</a>, <a class="el" href="classshark_1_1_training_progress.html#a7a77079e0170e3ebb94ee452e8c96bae">shark::TrainingProgress&lt; PointType &gt;::m_meanPerformance</a>, <a class="el" href="classshark_1_1_training_progress.html#aab3746ac8b741a666ad8c1eb5bb115e3">shark::TrainingProgress&lt; PointType &gt;::m_minTraining</a>, and <a class="el" href="classshark_1_1_training_progress.html#ac49c25a85c635d8930a4b4216f787a8a">shark::TrainingProgress&lt; PointType &gt;::m_progress</a>.</p>

<p class="reference">Referenced by <a class="el" href="classshark_1_1_training_progress.html#a519e14c11c239f4aae0a1d0cf82b792f">shark::TrainingProgress&lt; PointType &gt;::TrainingProgress()</a>.</p>

</div>
</div>
<a id="af320c01d4e54853e8fd3e891488bfba4" name="af320c01d4e54853e8fd3e891488bfba4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af320c01d4e54853e8fd3e891488bfba4">&#9670;&#160;</a></span>stop()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class PointType  = RealVector&gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool <a class="el" href="classshark_1_1_training_progress.html">shark::TrainingProgress</a>&lt; PointType &gt;::stop </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classshark_1_1_training_progress.html#a313c1aa65f6489d735fce017d01cfc94">ResultSet</a> &amp;&#160;</td>
          <td class="paramname"><em>set</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>returns true if training should stop </p>

<p class="definition">Definition at line <a class="el" href="_training_progress_8h_source.html#l00071">71</a> of file <a class="el" href="_training_progress_8h_source.html">TrainingProgress.h</a>.</p>

<p class="reference">References <a class="el" href="classshark_1_1_training_progress.html#a28ee365a24266f795f928be8e9352ba3">shark::TrainingProgress&lt; PointType &gt;::m_interval</a>, <a class="el" href="classshark_1_1_training_progress.html#a932d896b5b2d8b2689caef279c710b2d">shark::TrainingProgress&lt; PointType &gt;::m_intervalSize</a>, <a class="el" href="classshark_1_1_training_progress.html#a7a77079e0170e3ebb94ee452e8c96bae">shark::TrainingProgress&lt; PointType &gt;::m_meanPerformance</a>, <a class="el" href="classshark_1_1_training_progress.html#ae3ac4627d5824dd0f29d551fdc3857c6">shark::TrainingProgress&lt; PointType &gt;::m_minImprovement</a>, <a class="el" href="classshark_1_1_training_progress.html#aab3746ac8b741a666ad8c1eb5bb115e3">shark::TrainingProgress&lt; PointType &gt;::m_minTraining</a>, <a class="el" href="classshark_1_1_training_progress.html#ac49c25a85c635d8930a4b4216f787a8a">shark::TrainingProgress&lt; PointType &gt;::m_progress</a>, and <a class="el" href="structshark_1_1_result_set.html#abfb2c7bc8ee3b184bbef15cb250ead50">shark::ResultSet&lt; SearchPointT, ResultT &gt;::value</a>.</p>

</div>
</div>
<a id="aff4a12440a29b6dc3f9ace7b11642a7c" name="aff4a12440a29b6dc3f9ace7b11642a7c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aff4a12440a29b6dc3f9ace7b11642a7c">&#9670;&#160;</a></span>value()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class PointType  = RealVector&gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">double <a class="el" href="classshark_1_1_training_progress.html">shark::TrainingProgress</a>&lt; PointType &gt;::value </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>returns current value of progress </p>

<p class="definition">Definition at line <a class="el" href="_training_progress_8h_source.html#l00097">97</a> of file <a class="el" href="_training_progress_8h_source.html">TrainingProgress.h</a>.</p>

<p class="reference">References <a class="el" href="classshark_1_1_training_progress.html#ac49c25a85c635d8930a4b4216f787a8a">shark::TrainingProgress&lt; PointType &gt;::m_progress</a>.</p>

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a28ee365a24266f795f928be8e9352ba3" name="a28ee365a24266f795f928be8e9352ba3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a28ee365a24266f795f928be8e9352ba3">&#9670;&#160;</a></span>m_interval</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class PointType  = RealVector&gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">std::queue&lt;double&gt; <a class="el" href="classshark_1_1_training_progress.html">shark::TrainingProgress</a>&lt; PointType &gt;::m_interval</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>current interval </p>

<p class="definition">Definition at line <a class="el" href="_training_progress_8h_source.html#l00111">111</a> of file <a class="el" href="_training_progress_8h_source.html">TrainingProgress.h</a>.</p>

<p class="reference">Referenced by <a class="el" href="classshark_1_1_training_progress.html#a6244cca3d61f3d5ce1dee922ed9415ff">shark::TrainingProgress&lt; PointType &gt;::reset()</a>, and <a class="el" href="classshark_1_1_training_progress.html#af320c01d4e54853e8fd3e891488bfba4">shark::TrainingProgress&lt; PointType &gt;::stop()</a>.</p>

</div>
</div>
<a id="a932d896b5b2d8b2689caef279c710b2d" name="a932d896b5b2d8b2689caef279c710b2d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a932d896b5b2d8b2689caef279c710b2d">&#9670;&#160;</a></span>m_intervalSize</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class PointType  = RealVector&gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">size_t <a class="el" href="classshark_1_1_training_progress.html">shark::TrainingProgress</a>&lt; PointType &gt;::m_intervalSize</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>size of the interval </p>

<p class="definition">Definition at line <a class="el" href="_training_progress_8h_source.html#l00113">113</a> of file <a class="el" href="_training_progress_8h_source.html">TrainingProgress.h</a>.</p>

<p class="reference">Referenced by <a class="el" href="classshark_1_1_training_progress.html#af320c01d4e54853e8fd3e891488bfba4">shark::TrainingProgress&lt; PointType &gt;::stop()</a>, and <a class="el" href="classshark_1_1_training_progress.html#a519e14c11c239f4aae0a1d0cf82b792f">shark::TrainingProgress&lt; PointType &gt;::TrainingProgress()</a>.</p>

</div>
</div>
<a id="a7a77079e0170e3ebb94ee452e8c96bae" name="a7a77079e0170e3ebb94ee452e8c96bae"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7a77079e0170e3ebb94ee452e8c96bae">&#9670;&#160;</a></span>m_meanPerformance</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class PointType  = RealVector&gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">double <a class="el" href="classshark_1_1_training_progress.html">shark::TrainingProgress</a>&lt; PointType &gt;::m_meanPerformance</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>mean performance over the last intervalSize timesteps </p>

<p class="definition">Definition at line <a class="el" href="_training_progress_8h_source.html#l00106">106</a> of file <a class="el" href="_training_progress_8h_source.html">TrainingProgress.h</a>.</p>

<p class="reference">Referenced by <a class="el" href="classshark_1_1_training_progress.html#a6244cca3d61f3d5ce1dee922ed9415ff">shark::TrainingProgress&lt; PointType &gt;::reset()</a>, and <a class="el" href="classshark_1_1_training_progress.html#af320c01d4e54853e8fd3e891488bfba4">shark::TrainingProgress&lt; PointType &gt;::stop()</a>.</p>

</div>
</div>
<a id="ae3ac4627d5824dd0f29d551fdc3857c6" name="ae3ac4627d5824dd0f29d551fdc3857c6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae3ac4627d5824dd0f29d551fdc3857c6">&#9670;&#160;</a></span>m_minImprovement</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class PointType  = RealVector&gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">double <a class="el" href="classshark_1_1_training_progress.html">shark::TrainingProgress</a>&lt; PointType &gt;::m_minImprovement</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>minimum improvement allowed before training stops </p>

<p class="definition">Definition at line <a class="el" href="_training_progress_8h_source.html#l00104">104</a> of file <a class="el" href="_training_progress_8h_source.html">TrainingProgress.h</a>.</p>

<p class="reference">Referenced by <a class="el" href="classshark_1_1_training_progress.html#af320c01d4e54853e8fd3e891488bfba4">shark::TrainingProgress&lt; PointType &gt;::stop()</a>, and <a class="el" href="classshark_1_1_training_progress.html#a519e14c11c239f4aae0a1d0cf82b792f">shark::TrainingProgress&lt; PointType &gt;::TrainingProgress()</a>.</p>

</div>
</div>
<a id="aab3746ac8b741a666ad8c1eb5bb115e3" name="aab3746ac8b741a666ad8c1eb5bb115e3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aab3746ac8b741a666ad8c1eb5bb115e3">&#9670;&#160;</a></span>m_minTraining</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class PointType  = RealVector&gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">double <a class="el" href="classshark_1_1_training_progress.html">shark::TrainingProgress</a>&lt; PointType &gt;::m_minTraining</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>minimum training error encountered </p>

<p class="definition">Definition at line <a class="el" href="_training_progress_8h_source.html#l00102">102</a> of file <a class="el" href="_training_progress_8h_source.html">TrainingProgress.h</a>.</p>

<p class="reference">Referenced by <a class="el" href="classshark_1_1_training_progress.html#a6244cca3d61f3d5ce1dee922ed9415ff">shark::TrainingProgress&lt; PointType &gt;::reset()</a>, and <a class="el" href="classshark_1_1_training_progress.html#af320c01d4e54853e8fd3e891488bfba4">shark::TrainingProgress&lt; PointType &gt;::stop()</a>.</p>

</div>
</div>
<a id="ac49c25a85c635d8930a4b4216f787a8a" name="ac49c25a85c635d8930a4b4216f787a8a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac49c25a85c635d8930a4b4216f787a8a">&#9670;&#160;</a></span>m_progress</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class PointType  = RealVector&gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">double <a class="el" href="classshark_1_1_training_progress.html">shark::TrainingProgress</a>&lt; PointType &gt;::m_progress</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>current progress measure. if it is below minTraining, <a class="el" href="classshark_1_1_training_progress.html#af320c01d4e54853e8fd3e891488bfba4" title="returns true if training should stop">stop()</a> will return true </p>

<p class="definition">Definition at line <a class="el" href="_training_progress_8h_source.html#l00108">108</a> of file <a class="el" href="_training_progress_8h_source.html">TrainingProgress.h</a>.</p>

<p class="reference">Referenced by <a class="el" href="classshark_1_1_training_progress.html#a6244cca3d61f3d5ce1dee922ed9415ff">shark::TrainingProgress&lt; PointType &gt;::reset()</a>, <a class="el" href="classshark_1_1_training_progress.html#af320c01d4e54853e8fd3e891488bfba4">shark::TrainingProgress&lt; PointType &gt;::stop()</a>, and <a class="el" href="classshark_1_1_training_progress.html#aff4a12440a29b6dc3f9ace7b11642a7c">shark::TrainingProgress&lt; PointType &gt;::value()</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>include/shark/Algorithms/StoppingCriteria/<a class="el" href="_training_progress_8h_source.html">TrainingProgress.h</a></li>
</ul>
</div><!-- contents -->
</div>
</body>
</html>
